'\" t
.TH status 1 "14 May 2008" "Code Manager II"

.SH NAME
status \- Check for checked out files

.SH SYNOPSIS
status [-A|\fB--level\fP \fIdir|project\fP] [\fB--sanity\fP] [\fB--noignore\fP] [\fB--verbose\fP]
       [\fB--project\fP \fIproject\fP] [\fB--xml\fP]

.SH DESCRIPTION
The \fIstatus(1)\fP utility is used to work out which files are currently checked
out for a project. By default it will return the results for the current
working directory.

When returning results the format of the output will be similar to the following:

.TS
l.
Checked out files:
  status               :   snedward : 4b35ebc96e970107eb2b5474bbc02aad18c01223 [18]
.TE

For each file the name is given, the user that checked out the file, and the 
digital signature of the file and the local version number.

.SH ARGUMENTS
.TP 8
.B --verbose
Show more information regarding the file checking process, including the 
back-end repository type, and any ignore file pattern settings.
.TP
.B --level
By default the utility will work on just the files in the current
working directory. If this option is specified with the \fBproject\fP
argument the results over the whole project are shown.
.TP
.B --noignore
Include details of all files in the directory rather than just those
that do not match any ignore file patterns defined for the project.
.TP
.B -A,--project
Do not show details for the current directory, but instead show
all details for the project name specified. The name given can
be a project alias if necessary.
.TP
.B --sanity
Rather than just indicate details of any checked out files 
perform more vigorous checks and include details of potential
problems. These include:
.RS 8
.TP
.B [1]
Check for any files that are currently writable, but are not 
currently checked out.
.TP
.B [2]
Show details of any files that are under code control, but
the contents of which do not match any version under code 
control whilst the file is not being checked out.
.TP
.B [3]
If the \fBSOURCE_OWNER_GROUP\fP is set and any files have a 
different owner or group these will be listed.
.RE

.TP
.B --xml
Produce the results in an XML format rather than a more 
human-readable version. When this is used the output
format will be similar to the following if the \fB--xml\fP
option is not used:

.TS
l.
<?xml version="1.0" standalone="yes"?>
<status>
  <project name="codemgr2" rcs="/sas/rcs/projects/codemgr2/bin"/>
  <checked_out>
    <file name="status" by="snedward" md5="4b35ebc96e970107eb2b5474bbc02aad18c01223" ver="18"/>
  </checked_out>
</status>
.TE

If the \fB--sanity\fP option has been specified then the results
make use of the following format:

.TS
l.
<?xml version="1.0" standalone="yes"?>
<status>
  <project name="codemgr2" rcs="/sas/rcs/projects/codemgr2/bin"/>
  <checked_out>
    <file name="status" by="snedward" md5="4b35ebc96e970107eb2b5474bbc02aad18c01223" ver="18"/>
  </checked_out>
  <non_current_content>
    <file name="tagrelease" severity="Error" txt="Not checked out and unrecognised content!"/>
  </non_current_content>
  <writable_not_checked_out>
    <file name="updated"/>
  </writable_not_checked_out>
</status>
.TE

.SH EXIT CODES
The \fIstatus(1)\fP follows UNIX standard practise:

.TP 4
.B 0
Details have been successfully returned.
.TP
.B >0
The command encountered an unexpected error.

.SH AUTHOR
The \fBCode Manager II\fP tool set was written by Simon Edwards, Proprius Consulting Ltd, (\fBwww.proprius.co.uk\fP).

.SH SEE ALSO
.BR cm2(1),
.BR cm2_cpproject(1),
.BR cm2_mci(1),
.BR cm2_mget(1),
.BR cm2_mco(1),
.BR cm2_munlock(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP.

